home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / rats100.zip / RATS.DOC next >
Text File  |  1990-11-25  |  18KB  |  503 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                                    - RATS 1.00 -
  17.  
  18.                            RemoteAccess TimeBank System
  19.                               Version 1.00 - release
  20.                                   Copyright 1990
  21.                                 Motor City Software
  22.                                 All Rights Reserved
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. -----------------------------------------------------------------------------
  71.  
  72.  ** I M P O R T A N T   N O T I C E **
  73. -----------------------------------------------------------------------------
  74. The RATS data file structure has been changed in this release.  If you are
  75. running a previous version of RATS, you will need to reconfigure RATS using
  76. RATSCFG.EXE
  77.  
  78. -----------------------------------------------------------------------------
  79.  
  80. Introduction
  81. -----------------------------------------------------------------------------
  82. The RemoteAccess TimeBank System (henceforth known as RATS) is a user time-
  83. banking system for RemoteAccess and QuickBBS.  It has many features for the
  84. user and Sysop alike and allows users to bank online time and download
  85. kilobytes for use at a later date.
  86.  
  87. RATS also supports programs which automatically deposit minutes in user
  88. accounts using the THEBANK.EXT external support file (see External Game
  89. Support).
  90.  
  91. At the time of this release, RATS works with RemoteAccess versions 0.01
  92. through 0.04a and QuickBBS 2.64.  RATS will automatically detect and
  93. support the format of these two packages' EXITINFO.BBS files.
  94.  
  95. RATS has a separate maintenance program called RMU (RATS Maintenance Utility)
  96. which takes care of the RATS data file RATS.DAT.  It performs tasks ranging
  97. from deleting zero-balance accounts and users who are no longer in the
  98. USERS.BBS file to sorting accounts in last name order.
  99.  
  100. RATS provides hot-key support.  If the user is familiar with the commands,
  101. the current screen output can be interrupted when a command key is pressed.
  102. This can really speed things along!
  103.  
  104. RATS has a graphic transaction screen and uses Sysop-definable colors for
  105. most fields and prompts.
  106.  
  107. RATS recognizes the Sysop when he/she logs in and affords the <S>ysop Admin.
  108. command which basically allows the Sysop to make balance changes or delete
  109. certain user accounts.  RATS assumes that the user is the Sysop if the
  110. current user name is equal to that of the Sysop name as defined by your BBS.
  111.  
  112. RATS allows the Sysop to define values for maximum time deposit, maximum time
  113. withdrawal, maximum kilobyte deposit, maximum kilobyte withdrawal, maximum
  114. time transfer and maximum purchaseable kilobytes as well as default prompt
  115. foreground, prompt background, and prompt highlight colors to be used.
  116.  
  117. RATS now supports Multi-Line Systems! You can have more than one user in
  118. the bank at the same time. You MUST be running SHARE.EXE for multi-node
  119. support.
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132. -----------------------------------------------------------------------------
  133.  
  134. Licensing Information
  135. -----------------------------------------------------------------------------
  136. This program is not freeware.  This is SHAREWARE which means it is user-
  137. supported software.  If you use this program for more than 30 days, you are
  138. asked to register or remove it from your system.  $10.00 is not a lot to ask.
  139.  
  140. The concept works only  with your support.  If  you find that you  can
  141. use this program, then  a registration fee of  $10.00 U.S. funds  will
  142. help defray the development cost and encourage the authorship of other
  143. programs that might be  useful to you.  A  Registration Form for  this
  144. purpose is included with the RATS distribution archive and is called
  145. RATSREG.DOC.
  146.  
  147. RATS is Copyrighted 1990 by Motor City Software, ALL RIGHTS RESERVED.
  148. You may copy this program and documentation for backup purposes.
  149. You also may copy and share UNMODIFIED copies of the program package,
  150. providing that the copyright notice is reproduced and included on all copies.
  151.  
  152. You may not sell the product for a fee and/or distribute the product
  153. along with other products without expressed written permission, nor may
  154. you modify or remove the Copyright Notice from the program or the
  155. documentation.
  156.  
  157. Motor City Software shall not be held responsible for any damage incurred by
  158. the user to hardware, software or peripheral devices during the operation of
  159. the RATS program.  This program has been tested on a PC/XT clone using
  160. both COM1 and COM2 configurations and also on an AT clone using a COM1
  161. configuration.  Support is included for COM3 and COM4 as well.
  162.  
  163. Comments, suggestions and bug reports are welcome.  If you have any,
  164. you may call one of the Motor City Software Support Systems listed below,
  165. and leave a message to the Sysop.  If you're reporting a bug, please give
  166. as much detail as possible about the problem you are having.
  167.  
  168.  
  169. Motor City Software Support Systems
  170.  
  171. BBS Name                City                    Phone           Net Address
  172. --------                ----                    -----           -----------
  173. Motor City Software     Oshawa, Ont. Can.       (416) 579-6318  1:229/418
  174. ComPro Systems          Bowmanville Ont Can.    (416) 623-5148  1:229/414
  175. City Terminal BBS       Hopkins, Minnesota      (612) 938-4301  1:282/12
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204. -----------------------------------------------------------------------------
  205.  
  206. Distribution Files
  207. -----------------------------------------------------------------------------
  208. This program is distributed in archive (PKZip) format.  The distribution
  209. archive contains the files:
  210.  
  211.         RATSCFG.EXE           The RATS configuration program
  212.         RATS.DOC              This documentation file
  213.         RATS100.EXE           The program executable
  214.         RMU.EXE               RATS maintenance utility
  215.         RATS.HLP              The program help file
  216.         RATS.NEW              Program revision history (read this!!)
  217.         RATSREG.DOC           Registration form (please register!)
  218.         REGISTER.LST          List of registered sites
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239. -----------------------------------------------------------------------------
  240.  
  241. Getting Started -- Installation
  242. -----------------------------------------------------------------------------
  243. Unpack the distribution archive into the directory you'll run RATS in.  RATS
  244. can be run in any subdirectory as long as paths are setup properly in
  245. RATSCFG.EXE.  But for purposes of interfacing with some time door programs,
  246. it is recommended that you run RATS in the RA system directory.  Run the
  247. RATSCFG.EXE program to create/edit the RATS configuration file.
  248.  
  249. MULTI-LINE users!  You must create a seperate configuration file for each
  250. node!  Run RATSCFG 1 for node 1, RATSCFG 2 for node 2 etc. This will create
  251. RATS1.CFG and RATS2.CFG
  252.  
  253. If you are running single node, then just run RATSCFG
  254.  
  255. Once in RATSCFG, you may press F1 on any given field for help information
  256. for that field.
  257.  
  258. Once you are satisfied with the configuration, press ALT-X to exit and save
  259. it.
  260.  
  261. If you are running RemoteAccess you can execute RATS from a type 7 menu
  262. entry.  If you are running QuickBBS, you will need to run RATS as a type
  263. 15 exit with errorlevel set.  Batch file coding is beyond the scope of this
  264. document and will not be covered here.  For more information, please consult
  265. your BBS software documentation.
  266.  
  267. That's all there is to it!  RATS is easy to install and to use.
  268.  
  269.  
  270.  
  271. -----------------------------------------------------------------------------
  272.  
  273. Getting Started -- Command Line Parameters
  274. -----------------------------------------------------------------------------
  275. RATS accepts two command line parameters:
  276.  
  277.     /E - This  tells  RATS  not  to read any upcoming system event
  278.     information.  Some systems do not define any events within the
  279.     BBS and RATS doesn't like finding no events.    If  you  don't
  280.     have any events defined within your  BBS,  pass this parameter
  281.     to RATS.  I would recommend having at least one event  defined
  282.     within  your BBS as RATS thinks this is an ideal configuration
  283.     and loves the heck out of it! <grin>
  284.  
  285.     IMPORTANT NOTES ABOUT EVENTS:
  286.  
  287.     If you have ANY system events that require a user to be off at
  288.     a specific time,  you  MUST  have these events defined in your
  289.     BBS event schedule or RATS will  allow  users to withdraw time
  290.     that would overlap the system event time.
  291.  
  292.     So, if you are using a front end event scheduler and are pass-
  293.     ing the 'time to next event' to  your  BBS  via a command-line
  294.     parameter, RATS has no way of knowing the 'time to next event'
  295.     information.  To the author's knowledge, neither QuickBBS 2.64
  296.     or RemoteAccess 0.04a make this information accessible.   This
  297.     is why all events  MUST  be duplicated in the BBS event sched-
  298.     ular.
  299.  
  300.     If you  just  plain  don't  have  any  system events, then you
  301.     should use the /E command line parameter when  executing  RATS
  302.     (as above).
  303.   
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.     /I - Causes  RATS  to  perform an 'Inquire'.    This  is  used
  311.     by Bob Butler's BitSpin game.     DORINFO1.DEF  will be opened
  312.     and the current online user's name retrieved  from  it.  Next,
  313.     RATS will search it's data file for this user  and  return the
  314.     user's name and current account balance in the format:
  315.  
  316.                            USER_NAME:BALANCE
  317.  
  318.     Where USER_NAME  is  the  user's full  name  (just as it is in
  319.     DORINFO1.DEF for  that matter - no underscores) and BALANCE is
  320.     the  user's  current  balance.    If the user does not have an
  321.     account, a balance of 0 will be returned.
  322.  
  323.     This  information is then written  to  a  file called RATS.TYM
  324.     which  is a standard ASCII text file.  RATS will overwrite any
  325.     existing RATS.TYM file.  This file will be written in the same
  326.     directory that contains RATS.EXE.
  327.  
  328.     This feature was added to support  door programs which need to
  329.     read a user's current balance.
  330.  
  331.     If you pass the /I parameter to RATS, the specified task will
  332.     be performed and then RATS will exit to DOS.  RATS will NOT
  333.     come up for online use when this parameter is passed to it
  334.     since its sole purpose is to allow other door programs to
  335.     retrieve the current user's account balance.
  336.  
  337.  
  338.     /NOLIST  Passing this on the command line will disable the users
  339.     from listing other users balances.
  340.  
  341.     /N This is used to pass the Node Number in a multi-node system.
  342.     If you are running a single node system, ignore this. Otherwise
  343.     you pass /N1 for node 1, /N2 for node 2 etc... You will be required
  344.     to create a seperate configuration file for each node. See notes
  345.     on RATSCFG.EXE
  346.  
  347.  
  348.  
  349. For normal single line operation, RATS doesn't need any command line
  350. parameters passed to it.
  351.  
  352.  
  353.  
  354.  
  355. -----------------------------------------------------------------------------
  356.  
  357. External Files -- Minimum Usage File - RATSUSE.TXT
  358. -----------------------------------------------------------------------------
  359. If you configure RATS to require a user to use the BBS for a given amount of
  360. time before being able to make a deposit (of time or kilobytes) and a user
  361. attempts to make a deposit before using the BBS for the minimum required
  362. time, RATS will display a text file called RATSUSE.TXT, if it exits.  If it
  363. does not exist, a short message will be displayed.
  364.  
  365. This was added to support those Sysops who do not wish to have users logon
  366. only to deposit all of their time and then logoff.  If you set the minimum
  367. usage time in RATSCFG to 5 minutes, for example, and a user logs on and
  368. attempts to make a deposit before using the BBS for 5 minutes, the file
  369. RATSUSE.TXT is displayed.  Once the user has used the BBS for 5 minutes or
  370. more, the user is then allowed to make a deposit.
  371.  
  372.  
  373.  
  374. -----------------------------------------------------------------------------
  375.  
  376. External Files -- Bummer List -- RATS.BUM and RATSBUM.TXT
  377. -----------------------------------------------------------------------------
  378. RATS supports a 'bummer list' which is an ASCII text file list of user names
  379. that you do not want to have access to RATS.  This text file must have no
  380. blank lines.  Each line contains one full user name.  The user name can be
  381. in upper or lower case.  RATS will convert the names to upper case when it
  382. reads them.  The name of the text file is RATS.BUM.  If RATS finds this
  383. file upon startup, it will process it.
  384.  
  385. If a user who is on the bummer list tries to fire up RATS, RATS will look for
  386. a file called RATSBUM.TXT.  If found, this file will be displayed.  Otherwise,
  387. a default, one-line message will be displayed.
  388.  
  389.  
  390.  
  391. -----------------------------------------------------------------------------
  392.  
  393. External Game Support
  394. -----------------------------------------------------------------------------
  395. RATS is compatible with programs which utilize an external, automatic
  396. time-banking file (THEBANK.EXT) in that RATS will read this file and apply
  397. deposits and/or withdrawals automatically, to user accounts.
  398.  
  399. This means that RATS allows other door programs to automatically deposit
  400. or withdraw time from user accounts.  This can be quite handy, especially
  401. for door programs that offer time gambling or other time manipulation
  402. features.
  403.  
  404. So how does this work?  In RATSCFG, you entered a path to the external time
  405. bank support file THEBANK.EXT.  Whenever RATS is started, it looks for this
  406. file in the path you have set up.  If found, RATS performs the following
  407. tasks:
  408.  
  409.  o - Reads a line from THEBANK.EXT and retrieves the user name for the
  410.      transaction and the amount of the transaction.
  411.  
  412.  o - Searches the RATS data file for this user.  If the user does not
  413.      have an account, one is created.
  414.  
  415.  o - Applies the amount to be transacted.  This amount may be a positive or
  416.      a negative number.  If the number is negative, then the amount is
  417.      withdrawn from the user's account.  If the number is positive, the
  418.      amount is deposited.
  419.  
  420. So, what's the format of this external support file?  THEBANK.EXT is simply
  421. an ASCII text file consisting of no blank lines.  Each line must contain a
  422. transaction.  Here's a sample THEBANK.EXT file;  we will be depositing 30
  423. minutes in Jane Doe's account and withdrawing 30 minutes from John Doe's
  424. account:
  425.  
  426. <top of file>
  427. JANE DOE:30
  428. JOHN DOE:-30
  429. <end of file>
  430.  
  431. There is no limit to the number of transactions in THEBANK.EXT.  However,
  432. the more there are to process the longer it will take RATS to load since
  433. RATS looks for and processes this file each time it is loaded.
  434.  
  435.  
  436.  
  437. -----------------------------------------------------------------------------
  438.  
  439. External Files -- RATSMIN.TXT
  440. -----------------------------------------------------------------------------
  441. If a user fires up RATS and has a security level less than the Minimum
  442. Security value defined in RATSCFG, the text file RATSMIN.TXT is displayed,
  443. if it exists in the directory containing RATS.EXE.  If this file does not
  444. exist, a one-line message will be displayed.  The user is then returned to
  445. the BBS.
  446.  
  447. This is useful for Sysops who would like to tell users how to get access to
  448. RATS if their security level is not high enough.  The Sysop can then set the
  449. security level on the menu entry that calls RATS to a lower level than what
  450. is actually required to have access to it.
  451.  
  452.  
  453.  
  454. -----------------------------------------------------------------------------
  455.  
  456. RMU -- Rats Maintenance Utility
  457. -----------------------------------------------------------------------------
  458. The RMU program accepts one command line parameter and that is the path to
  459. USERS.BBS.  RMU should be run in the same directory that contains RATS.DAT.
  460. Just pass the path to your USERS.BBS file.  For example:
  461.  
  462.                                 RMU \RA\MsgBase\
  463.                                 RMU \QuickBBS\
  464.  
  465. That's all that RMU requires to execute.  Ideally, RMU might be run on a
  466. daily basis as part of routine BBS maintenance.
  467.  
  468. Once executed, RMU performs the following maintenance tasks on the RATS
  469. data file:
  470.  
  471.  o - Deletes users whose account balances are zero minutes and zero
  472.      kilobytes.  To retain an account in RATS, a user must have at least
  473.      one minute of time or one kilobyte on account.
  474.  
  475.  o - Cross referrences USERS.BBS and removes users who no longer exist in
  476.      the USERS.BBS file.
  477.  
  478.  o - Sorts all accounts in last name order.
  479.  
  480.  
  481. -----------------------------------------------------------------------------
  482.  
  483. Notes From the Author
  484. -----------------------------------------------------------------------------
  485.  
  486. John Parlin, the author of RATS has joined Motor City Software as a partner,
  487. and all support will be handled through the main Motor City Software Online
  488. support BBS.
  489.  
  490. If you have any helpful comments, suggestions or bug reports, please feel
  491. free to contact us.
  492.  
  493. Please address all concerns to Rod Hancock at 1:229/418
  494.  
  495. We also have available, a Motor City Software support echo, and if you are
  496. interested, we can point you to the closest system to you which carries it.
  497. Currently its not on the FidoNet backbone, but with enough interest in it,
  498. who knows...
  499.  
  500. If you use RATS for 30 days, you are required to register it or remove it
  501. from your system. Please support us, so we may support you....
  502.  
  503.